home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / ds_101a.zip / DOORSTAT.DOC next >
Text File  |  1992-01-19  |  10KB  |  352 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.                   ┌───────────────────────────────────┐
  29.                   │                                   │█
  30.                   │       DoorStat version 1.01a      │█
  31.                   │                                   │█
  32.                   │       Baker Street Software       │█
  33.                   │                                   │█
  34.                   │           Brent Herring           │█
  35.                   │                                   │█
  36.                   └───────────────────────────────────┘█
  37.                     ████████████████████████████████████
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.     Introduction
  63.     ------------------------------------------------------------------
  64.  
  65.     DoorStat  will track  the usage  of doors  on your BBS,  producing
  66.     both  graphical and  tabular bulletins  to display on your system.
  67.  
  68.     Files contained in the DoorStat Archive are:
  69.  
  70.           DOORSTAT.EXE     - main program
  71.           DOORSTAT.DOC     - this file
  72.           REGISTER.FRM     - registration form
  73.           WHATSNEW.101     - program changes from last version
  74.           README.1ST       - note on upgrading
  75.  
  76.     Other associated files
  77.  
  78.           DOORSTAT.CTL     - list of door names
  79.           DOORSTAT.DAT     - data file used by DoorStat
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.     Legalese
  123.     ------------------------------------------------------------------
  124.  
  125.     1. "DoorStat" refers to the executable programs and  documentation
  126.        contained  in the  DoorStat  distribution  archive released  by
  127.        Baker Street Software.
  128.  
  129.     2. Baker Street Software  is in no way obligated to provide future
  130.        versions of, or support for, DoorStat.
  131.  
  132.     3. You  may not  modify or  otherwise  reverse-engineer  DoorStat.
  133.  
  134.  
  135.     4. The software and accompanying materials (including instructions
  136.        for use) are provided  "as  is"  without  warranty of any kind.
  137.        Further, the author does not warrant,  guarantee, or  make  any
  138.        representations  regarding the use,  or the results of the use,
  139.        of the software or written materials in terms  of  correctness,
  140.        accuracy, reliability, currentness or otherwise.
  141.  
  142.        The author(s) shall not be liable  for  any  direct,   indirect,
  143.        consequential, or incidental damages (including damages for loss
  144.        of business profits, business  interruption,  loss  of  business
  145.        information, and the like)  arising out  of the use or inability
  146.        to use the software even if the author has been advised  of  the
  147.        possibility of such damages.
  148.  
  149.  
  150.  
  151.     5. You  are free to distribute  this archive,  in fact I hope that
  152.        you do so.   However in  distribution please  observe these few
  153.        restrictions.
  154.  
  155.        a. All  the files  in the  original archive  must be  included.
  156.  
  157.        b. No  fee may  is charged  for its  distribution, and that the
  158.           distribution  archive  is  not  modified  in  any  way.  Pay
  159.           Bulletin Board Systems  may however  charge their normal fee
  160.           provided  that no  additional charge for DoorStat is levied.
  161.  
  162.        c. DoorStat may not be included as part of any software library
  163.           which  is distributed  on a  commercial basis  (commercial =
  164.           "for money")  without prior  written permission  from  Baker
  165.           Street Software.
  166.  
  167.  
  168.     6. Your  use of this software is considered agreement to these terms.
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.     Using DoorStat
  183.     ------------------------------------------------------------------
  184.  
  185.     Setting up DoorStat
  186.  
  187.     Step 1.  Create the .DAT and .CTL files
  188.  
  189.     Begin DoorStat by running DOORSTAT -RESET.   This parameter allows
  190.     you  to create  the support  files DOORSTAT.DAT  and DOORSTAT.CTL.
  191.     When  reseting the  .CTL file  you  will also be prompted to enter
  192.     your  BBS name.  However  you enter it  here is the way it will be
  193.     displayed   in  the   bulletins  the   program  generates.   After
  194.     creating  the files  you will be ready to create the list of doors
  195.     that you wish to track.   Running this  parameter will  also allow
  196.     you to reset either of these files in the future.  I.E. some might
  197.     wish to reset the data file at the beginning of each month or week
  198.     tracking door usage for only that length of time.
  199.  
  200.  
  201.     Step 2.  Creating your list of doors
  202.  
  203.     Run  DOORSTAT  -CONFIG.   This  brings  up  a  simple  editor  for
  204.     inputing,  changing, and/or  deleting the  list of  doors that you
  205.     wish  to track.   The file  DOORSTAT.CTL must exist in the current
  206.     directory  for this  option to  work.   Using this  option you may
  207.     enter/change  door names  and change the BBS name that you entered
  208.     when creating the file.  When you type in the name of the door you
  209.     must  observe the  following restrictions in order for the program
  210.     to accurately track your door usage.
  211.  
  212.     1.  The  name of  the door  that you  use with  the DOORSTAT -NAME
  213.         parameter  must match  that of the name in the list you create
  214.         exactly.  The program is case sensitive so,
  215.  
  216.         Know-it-all  is not the same as  know-it-all
  217.         Know it all  is not the same as  KnowItAll
  218.  
  219.  
  220.     2.  The  name of  the door  can be  no more than twenty characters
  221.         in length.
  222.  
  223.  
  224.     3.  A maximum  of  69  doors  may  be  tracked  in  this  version.
  225.  
  226.  
  227.     Keeping track of door usage
  228.  
  229.     Inputing tracking data
  230.  
  231.     To  keep track  of individual  door  usage  run DoorStat  with the
  232.     -NAME  <doorname>  parameter.   This will  store the  name of that
  233.     particular  door  in  the   DOORSTAT.DAT  file.    The  <doorname>
  234.     parameter  must follow  the same restrictions in the list of doors
  235.     you created with the -CONFIG parameter.  The -name <doorname> must
  236.     match the doorname in the list exactly.
  237.  
  238.  
  239.  
  240.  
  241.  
  242.     You  run DoorStat  with the -NAME parameter in the batch file that
  243.     calls your door.
  244.  
  245.     Example: => exit from bbs to door
  246.  
  247.                  :door
  248.                    doorstat -name door name
  249.                    cd\door
  250.                    run_door
  251.                    cd\bbs
  252.                    back to bbs
  253.  
  254.  
  255.     Producing DoorStat bulletins
  256.  
  257.     There are two parameters  used to produce the  DoorStat bulletins.
  258.     These  options should be run as often as you want the bulletins to
  259.     be  updated.   If you  track only  two or three doors then running
  260.     these  options with  every door  exit shouldn' t be  too much of a
  261.     problem,  but if you are tracking  several doors it can take a few
  262.     minutes  to run  this option  and you  will probably  want to wait
  263.     until  the user logs  off and run it before you bring the BBS back
  264.     up.   If currency  of the  data is  not a  concern a once a day in
  265.     your nightly maintenance will do.
  266.  
  267.     1. doorstat -stats <path>
  268.  
  269.        Example: doorstat -stats c:\bbs\txtfiles
  270.  
  271.        When  using this  parameter do not  include a traiing backslash
  272.        on the path.
  273.  
  274.        This  parameter will produce a tabular data file that lists the
  275.        doors  and shows a  number corresponding to the number of times
  276.        that each door has been played since the program was last
  277.        reset.
  278.  
  279.        The output file names are:
  280.  
  281.        DOORSTAT.ASC  -  ASCII file
  282.        DOORSTAT.ANS  -  ANSI file
  283.  
  284.  
  285.     2. doorstat -graph <path>
  286.  
  287.        Example: doorstat -graph c:\bbs\txtfiles
  288.  
  289.        When  using this  parameter do  not include a traiing backslash
  290.        on the path.
  291.  
  292.        This parameter will produce a graph of the data file that lists
  293.        the  doors and  shows a  bar graph with length corresponding to
  294.        the  number of  times that  each door has been played since the
  295.        program was last reset.  The output file names are:
  296.  
  297.        DOORGRAF.ASC  -  ASCII file
  298.        DOORGRAF.ANS  -  ANSI file
  299.  
  300.  
  301.     Baker Street Software Beta Testers
  302.     ------------------------------------------------------------------
  303.     Thanks to these guys for helping out with the testing.
  304.  
  305.  
  306.     Daryl McPhee             Presque Isle, Maine
  307.  
  308.     Northern Maine BBS       (207) 496-2391  (207) 436-6910
  309.  
  310.  
  311.  
  312.     Larry Beyers              Modesto, California
  313.  
  314.     Root Connection           (209) 576-1606
  315.  
  316.  
  317.  
  318.  
  319.     Registration/Support/Questions
  320.     ------------------------------------------------------------------
  321.  
  322.     If  you like  this program  please register it.   If you  register
  323.     this  program you will receive a registration number that  will be
  324.     valid  for all future versions of this program.   The program will
  325.     not say  [UNREGISTERED]  at the bottom of the  bulletins, but will
  326.     have  your name instead.   To register  complete the  registration
  327.     form and send $5.00 to
  328.  
  329.     =======================
  330.     Brent Herring
  331.     1922 Bruce Apt B-7
  332.     Conway, Arkansas  72032
  333.     =======================
  334.  
  335.     $5.00 isn't much is it?
  336.  
  337.     Once  you receive  your registration number you can  create a file
  338.     called DOORSTAT.KEY with your ASCII text editor.   The file should
  339.     contain the following information:
  340.  
  341.                           REGISTRATION NUMBER
  342.                           Your Name
  343.  
  344.     That's it.  Thanks.
  345.     Questions about this program can be directed to
  346.  
  347.     Brent Herring   Quantum Leap BBS  (501) 329-6240  Conway, Arkansas
  348.  
  349.     If you have a problem with the program you can contact me here and
  350.     I will do my best to help you solve it.
  351.     ------------------------------------------------------------------
  352.